

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pysiriproxy.testing.testSupport &mdash; pysiriproxy v0.0.7 documentation</title>
    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../',
        VERSION:     '0.0.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../../_static/doctools.js"></script>
    <link rel="top" title="pysiriproxy v0.0.7 documentation" href="../../../index.html" />
    <link rel="up" title="Module code" href="../../index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../index.html">pysiriproxy v0.0.7 documentation</a> &raquo;</li>
          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for pysiriproxy.testing.testSupport</h1><div class="highlight"><pre>
<span class="c"># Copyright (C) 2012 Brett Ponsler, Pete Lamonica</span>
<span class="c"># This file is part of pysiriproxy.</span>
<span class="c">#</span>
<span class="c"># pysiriproxy is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU General Public License as published by</span>
<span class="c"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c"># (at your option) any later version.</span>
<span class="c">#</span>
<span class="c"># pysiriproxy is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="c"># GNU General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU General Public License</span>
<span class="c"># along with pysiriproxy.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="sd">&#39;&#39;&#39;The testSupport class contains classes and utility functions designed</span>
<span class="sd">to aid the process of writing test modules for pysiriproxy.</span>

<span class="sd">&#39;&#39;&#39;</span>
<span class="kn">from</span> <span class="nn">pysiriproxy.constants</span> <span class="kn">import</span> <span class="n">Directions</span>

<span class="kn">from</span> <span class="nn">pyamp.logging</span> <span class="kn">import</span> <span class="n">LogData</span><span class="p">,</span> <span class="n">LogLevel</span><span class="p">,</span> <span class="n">Colors</span>


<div class="viewcode-block" id="Connection"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.Connection">[docs]</a><span class="k">class</span> <span class="nc">Connection</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;The Connection class implements the basic functionality of a</span>
<span class="sd">    :class:`.connections.Connection` which is used in responding to a</span>
<span class="sd">    request from Siri. This Connection class is compatible with</span>
<span class="sd">    the :class:`.connections.ConnectionManager` and the :class:`.PluginManager`</span>
<span class="sd">    and is used for testing purposes.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">Direction</span> <span class="o">=</span> <span class="bp">None</span>
    <span class="sd">&#39;&#39;&#39;The Direction property defines the direction that data is traveling for</span>
<span class="sd">    this Connection.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">RefId</span> <span class="o">=</span> <span class="bp">None</span>
    <span class="sd">&#39;&#39;&#39;The RefId property defines the reference ID for this Connection.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">Callback</span> <span class="o">=</span> <span class="bp">None</span>
    <span class="sd">&#39;&#39;&#39;The Callback property defines the callback function that is called</span>
<span class="sd">    in the event that an object is injected into the output stream of a</span>
<span class="sd">    connection.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Create a Connection.&#39;&#39;&#39;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">Direction</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">&quot;Must define the Direction property!&quot;</span><span class="p">)</span>

    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="Connection.getRefId"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.Connection.getRefId">[docs]</a>    <span class="k">def</span> <span class="nf">getRefId</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Return the RefId for this Connection.&#39;&#39;&#39;</span>
        <span class="k">return</span> <span class="n">cls</span><span class="o">.</span><span class="n">RefId</span>
</div>
    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="Connection.injectObjectToOutputStream"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.Connection.injectObjectToOutputStream">[docs]</a>    <span class="k">def</span> <span class="nf">injectObjectToOutputStream</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Inject the given object to the output stream.</span>

<span class="sd">        * obj -- The object to inject to the output stream</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">Callback</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
            <span class="c"># Have to pass an instance of the Connection to the callback</span>
            <span class="c"># function in order for it to work</span>
            <span class="n">cls</span><span class="o">.</span><span class="n">Callback</span><span class="p">(</span><span class="n">cls</span><span class="p">(),</span> <span class="n">obj</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">cls</span><span class="o">.</span><span class="n">__log</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
</div>
    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="Connection.getDirection"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.Connection.getDirection">[docs]</a>    <span class="k">def</span> <span class="nf">getDirection</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Get the data direction for this Connection.&#39;&#39;&#39;</span>
        <span class="k">return</span> <span class="n">cls</span><span class="o">.</span><span class="n">Direction</span>

    <span class="c">##### Private functions #####</span>
</div>
    <span class="nd">@classmethod</span>
    <span class="k">def</span> <span class="nf">__log</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Log an information message to the output.</span>

<span class="sd">        * message -- The message to log</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">logger</span> <span class="o">=</span> <span class="n">LogData</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">cls</span><span class="o">.</span><span class="n">Direction</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="n">Colors</span><span class="o">.</span><span class="n">Foreground</span><span class="o">.</span><span class="n">Red</span><span class="p">)</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>

</div>
<div class="viewcode-block" id="iPhone"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.iPhone">[docs]</a><span class="k">class</span> <span class="nc">iPhone</span><span class="p">(</span><span class="n">Connection</span><span class="p">):</span>
    <span class="sd">&#39;&#39;&#39;Create an iPhone Connection for testing.&#39;&#39;&#39;</span>

    <span class="n">Direction</span> <span class="o">=</span> <span class="n">Directions</span><span class="o">.</span><span class="n">From_iPhone</span>
    <span class="sd">&#39;&#39;&#39;Define the direction for this Connection to indicate that it is from</span>
<span class="sd">    the iPhone.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">RefId</span> <span class="o">=</span> <span class="s">&quot;iPhone refId&quot;</span>
    <span class="sd">&#39;&#39;&#39;Define the reference ID for the iPhone Connection.&#39;&#39;&#39;</span>

</div>
<div class="viewcode-block" id="Server"><a class="viewcode-back" href="../../../_generated/pysiriproxy_testing_testSupport.html#pysiriproxy.testing.testSupport.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</span><span class="p">(</span><span class="n">Connection</span><span class="p">):</span>
    <span class="sd">&#39;&#39;&#39;Create a Server Connection for testing.&#39;&#39;&#39;</span>

    <span class="n">Direction</span> <span class="o">=</span> <span class="n">Directions</span><span class="o">.</span><span class="n">From_Server</span>
    <span class="sd">&#39;&#39;&#39;Define the direction for this Connection to indicate that it is from</span>
<span class="sd">    Apple&#39;s web server.</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="n">RefId</span> <span class="o">=</span> <span class="s">&quot;Server refId&quot;</span>
    <span class="sd">&#39;&#39;&#39;Define the reference ID for the server Connection.&#39;&#39;&#39;</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../index.html">pysiriproxy v0.0.7 documentation</a> &raquo;</li>
          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>